home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
maximus
/
sqrep103.zip
/
SQREPORT.DOC
< prev
next >
Wrap
Text File
|
1992-03-08
|
8KB
|
204 lines
If you are upgrading from version 0.8 or 0.9, check the READTHIS file for
information on converting your data files.
S q R e p o r t
~~~~~~~~~~~~~~~
Bob Rakov, 1:203/53
The Second Opinion BBS
Folsom, CA
16 Feb 92, version 1.0
SqReport is a utility to report on the mail activity of your system based
on the log output from the SQUISH (version 1.0) mail tosser/scanner.
SqReport can scan your squish log (or the database you create) and provide
information regarding number of messages received, echomail packed for nodes
you feed, traffic reports for individual echoes and a report of dead areas.
Input
-----
The input for SqReport can be either your squish log, a database previously
created by SqReport or both; the log plus the database.
Output
------
The output for SqReport can be either local console, a specified report
file, database or any combination of the three. The database option is
useful for cumulative reports (weekly, monthly etc.)
HOW IT WORKS:
-------------
SqReport doesn't need to be in the current directory. If you do not store
it in your path, then prefix your call to SqReport with the drive and
directory location of the program.
Options Explained
-----------------
All options must be preceded by a '-'
SqReport -? yields the information screen:
Syntax --> SQreport [-lLogFile] [-dDataFile] [-rReportFile] [-k] [-q]
[-aAreaFile] [-sAreaFile] [-iNumber] [-oNumber]
[-cConfigFile]
-lLogFile
---------
This is the name of the log file created by SQUISH. If it is not in the
current directory, it must be preceded by the drive\directory location of
the log file. This file is optional, but if you don't specify a log file,
you need to specify a data file in order for SqReport to have something
useful to do. You can specify _both_ a log and data file.
-dDataFile
----------
This is the name of the data file created by SqReport. If it is not in
the current directory, or you don't want a data file created in the current
directory, it must be preceded by the drive\directory location of the data
file. This file is optional, but if you don't specify a data file, you need
to specify a log file in order for SqReport to have something useful to do.
You can specify _both_ a data and log file.
-rReportFile
------------
This is the name of the report file created by SqReport. If you don't
want the report file created in the current directory, it must be preceded
by the drive\directory location where you would like the report created.
This file is optional, if you don't specify a report file, and the 'quiet'
option is not on, the output will be sent to the local console.
-aAreaFile -sAreafile
---------- AND / OR ----------
Areas.Bbs Squish.Cfg
You may specify an areas.bbs file (-aAreas.Bbs) and/or a Squish.Cfg file
in order to tell SqReport the areas you carry.
This is the name of your areas.bbs file for squish. If it is not in the
current directory, it must be preceded by the drive\directory location of
the file. This file is optional. If you specify an areas.bbs file SqReport
will compare the echoes listed within to the echoes for which you've tossed
or scanned mail and produce a list of 'dead' echoes - ripe for deletion. The
format of this file must stricly adhere to the format described within the
sample areas.bbs and sample squish.cfg included with the SQUISH 1.0 archive.
-iNUMBER <messages>
--------
This is the threshold number messages for SqReport to use in producing a
report of inbound mail (either to the screen or report file). If a node
sends you greater than the theshold number of messages, it will be listed as
having sent the messages. If it has sent the threshold or below number of
messages, the messages it sent will be listed under messages from 'other'
systems. The default is 0, and all nodes sending you messages will have
their address listed.
-oNUMBER <bytes>
--------
This is the threshold number bytes for SqReport to use in producing a
report of outbound mail (either to the screen or report file). If a node
receives greater than the theshold number of bytes from you, it will be
listed in the output. If it receives the threshold or below number of bytes
from you, the number of bytes it receives will be listed under mail to
'other' systems. The default is 0, and all nodes you send mail to will have
their address listed. This option only affects screen & report file output.
If a data file is specified, the information for the individual nodes (up to
512) is maintained regardless of this setting.
-k
--
Kill. If a log is specified, kill it after processing.
-q
--
Quiet. Supress screen output. This is a bit faster if all you're doing is
updating the data file and/or creating a report file and don't need screen
output.
-cConfigFile
------------
All options specified on the command line can also be specified in a
configuration file. The command line options take priority and can override
the options specified in the config file. Command line parameters issued
with no modifiers can be used to cancel config file options. For instance,
entering -l -d -r -s -d -i -o with no modifiers will cancel whatever
cooresponding option was set in the config file. Entering any of these with
a modifier will override whatever was set in the config file.
EXAMPLES:
---------
:DoDay
SqReport -lSquish.Log -rDaily.Rpt -i10 -o30000 -q
SqReport -lSquish.Log -dWeekly.Dat -rWeekly.Rpt -i10 -o30000 -q
SqReport -lSquish.Log -dMonthly.Dat -rMonthly.Rpt -i10 -o30000 -q -k
Daily, I run three passes of SqReport:
First pass scans squish.log and creates the daily report, listing nodes that
have either sent me > 10 messages or received > 30k from me.
Second pass scans squish.log and updates (or creates) a weekly data file. It
then creates a report of what the traffic has been thusfar this week.
Third pass does the same thing as the second, only this time updating (or
creating) a monthly data file and creating a report of what the traffic has
been thusfar this month. The log file is deleted after the final pass.
:DoWeek
SqReport -dWeekly.Dat -rWeekly.Out -aAreas.Bbs -i10 -o30000
erase weekly.dat
Once per week I create a report for distribution to my nodes using the weekly
data file created above. Note here that no log was specified and that I'm
using Areas.Bbs to create a list of 'dead' echoes. After generating the
report, I delete the weekly data file. The next time the second of the three
daily passes described above is run, a fresh weekly data file will be
created.
I then use the enclosed program CARVE to carve up the rather long report into
message sized chunks and place then in the local sysop echo. See the
enclosed CARVE.DOC for further information.
:DoMonth
SqReport -dMonthly.Dat -rMonthly.Out -Aareas.Bbs -i10 -o30000
erase c:\squish\monthly.dat
Same as the weekly routine, only this time the activity for the entire month
is tabulated.
LIMITATIONS:
------------
1024 unique echo areas.
512 Unique addresses to list mail from/to. After 512 different nodes have
sent/received mail, the messages in / bytes out data is will be listed under
'other'.
WARRANTEE:
----------
Get real.
Dammit Jim, I'm a Doctor not a Programmer.
if BROKE then
user:='Owns Both Pieces'
if PROBLEMS/SUGGESTIONS then
contact:='Bob Rakov, The Second Opinion, 1:203/53'
if COMPLAINTS then
send to device > nul
For the latest version, request SQREPORT from 1:203/53 (HST/DS)
-bob